4.2.4.4 查询用户列表
可通过此接口在用户目录查询用户列表。
基本信息
请求地址：
https://SDPC-IP:4433/api/v3/user/queryAll请求方式：
POST
请求头（Header）
- 请求体（Body）
| 参数 | 中文名称 | 必须 | 类型 | 描述 |
|---|---|---|---|---|
| directoryDomain | 用户目录唯一标识 | 是 | string | 用户目录唯一标识，在控制台点击用户目录设置即可查看。 本地用户目录的唯一标识为 local。外部用户目录示例： custom01339（唯一标识无需携带@）。 |
| pageSize | 分页大小 | 否 | number | 查询数据会自动分页，此参数为每页包含数据的最大条数。 取值范围：0 < 分页大小 <= 5000。 默认值：20 |
| pageIndex | 分页索引 | 否 | number | 查询数据会自动分页，此参数为待查询的页面序号。 取值范围：0 < 分页索引 <= 1000000。 默认值：1 |
| searchByPath | 根据组织架构精确搜索 | 否 | string | 根据组织架构路径，精确搜索组织架构下的用户。 示例：/客服体系/专家中心/零信任专家组 |
| recursive | 根据组织架构精确搜索时，是否递归搜索子组 | 否 | number | 取值范围：1-递归（默认）0-不递归 |
| fuzzyMatch | 模糊搜索 | 否 | string | 针对用户属性进行模糊匹配，支持的属性： 用户名（忽略大小写） 用户显示名（忽略大小写） 所属组织架构（忽略大小写） 外部id 描述 手机号 邮箱地址 关联角色名 当存在 searchByPath 参数时，此参数将失效。 |
- 请求示例
curl --location --request POST 'https://SDPC-IP:4433/api/v3/user/queryAll?lang=zh-CN' \
--header 'Content-Type: application/json' \
--header 'X-Ca-Key: {{X-Ca-Key}}' \
--header 'X-Ca-Nonce: {{X-Ca-Nonce}}' \
--header 'X-Ca-TimeStamp: {{X-Ca-TimeStamp}}' \
--header 'X-Ca-Sign: {{X-Ca-Sign}}' \
--data-raw '{
"directoryDomain": "custom01339",
"pageSize": 100,
"pageIndex": 1,
"searchByPath": "/客服体系/专家中心/零信任专家组",
"recursive": 1
}'
- 返回数据
| 参数 | 中文名称 | 类型 | 描述 |
|---|---|---|---|
| code | 响应码 | string | OK 表示成功，其他表示出错。具体含义请参考错误码定义 |
| data | 响应数据 | object | |
| ├─ count | 数据总条数 | number | |
| ├─ pageCount | 当前页包含数据条数 | number | |
| ├─ pageSize | 分页大小参数 | number | |
| ├─ pageIndex | 分页索引参数 | number | |
| ├─ data | 用户数据 | object[] | |
| ├─├─ id | 用户id | string | 例如： 1345c177-e4f6-11ee-835b-fefcfeefe529 |
| ├─├─ name | 用户名称 | string | 例如： 张三 |
| ├─├─ displayName | 显示名 | string | |
| ├─├─ groupPath | 组织架构路径 | string | 例如： /客服体系/专家中心/零信任专家组 |
| ├─├─ description | 描述 | string | |
| 邮箱 | string | ||
| ├─├─ phone | 手机号 | string | |
| ├─├─ expiredTime | 过期时间 | string | 毫秒级别的Unix时间戳 示例： 1710745688563 |
| ├─├─ status | 启用状态 | number | 取值范围：0-禁用1-启用 |
| ├─├─ externalId | 外部id | string | 例如： 81dc9bdb52d04dc2 |
| ├─├─ isDeleted | 是否外部已删除 | string | 取值范围：0-否1-是 |
| msg | 描述信息 | string | |
| traceId | 调用链id | string |
- 响应示例
{
"code": "OK",
"data": {
"data": [
{
"id": "d8ab0f70-b8fd-11ee-8e5e-4d44b4d649f0",
"name": "张三",
"displayName": "张三-zhangsan",
"groupPath": "/",
"description": "通过openApi v3 创建",
"email": "zhangsan@xxx.com",
"phone": "12312341234",
"expiredTime": "0",
"status": 1,
"externalId": "user-extid-zhangsan",
"isDeleted": 0
},
{
"id": "aadc2220-b518-11ee-9057-03f304a1f8d4",
"name": "李四",
"displayName": "李四-lisi",
"groupPath": "/tmp",
"description": "",
"email": "xxx@a.as",
"phone": "11012341234",
"expiredTime": "0",
"status": 1,
"externalId": "user-extid-lisi",
"isDeleted": 0
}
]
},
"msg": "请求成功",
"traceId": "004c33070f4fa7b4"
}
错误码